/**
 * Copyright 2008 Adam Ruggles.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package kiff.dao;

import java.util.List;

import kiff.entity.Forum;
import kiff.enumerator.ForumStatus;
import kiff.exception.DataLayerException;

/**
 * Interface for Forum Data Access Objects.
 * @author Adam
 * @version $Id: ForumDAO.java 73 2008-12-02 06:28:25Z a.ruggles $
 */
public interface ForumDAO extends CoreDAO<Forum> {
	/**
	 * The name of the JPQL query to find a list of forums by their status.
	 */
	String FIND_BY_STATUS = "Forum.findByStatus";

	/**
	 * Returns forums by their statuses.
	 * @param statuses A list of statuses of the Forums to return.
	 * @return A {@link java.util.List} of Forums.
	 * @throws DataLayerException If an error occurs in the data layer.
	 */
	List<Forum> findByStatus(ForumStatus... statuses) throws DataLayerException;

	/**
	 * Returns the total number of forums for a given parent.
	 * @param parent The parent or null if there is no parent.
	 * @return The total number of forums for a given parent.
	 * @throws DataLayerException If an error occurs in the data layer.
	 */
	int findCountByParent(final Forum parent) throws DataLayerException;
}
